SureTax Returns 2.0 API

GET Generation Request Status

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint is utilized to continuously check the status of form generation requests until the process reaches its final completion status. It enables clients to monitor the progress of form generation activities until they are successfully completed or terminated.

OperationId: GET Generation Request Status

Authorization Method(s): OAuth

Verb: GET

End Point: /Forms/GenerationRequestStatus

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

GenerationRequestStatusResponse

OVERVIEWEXAMPLE

Overview

GenerationRequestStatusResponse

Display Name	Field Name	Field Type
Data	data	GenerationRequestStatus

GenerationRequestStatus

Display Name	Field Name	Field Type
Request Status	requestStatus	string
Form Instances	formInstances	array[FormInstanceDetails]
External Reporting Entity	externalReportingEntity	string

FormInstanceDetails

Display Name	Field Name	Field Type
Id	id	string
Form Id	formId	string
Reporting Period From Date	reportingPeriodFromDate	string
Reporting Period To Date	reportingPeriodToDate	string
Reporting Periodicity	reportingPeriodicity	string
Reporting Period Num	reportingPeriodNum	string
Reporting Phase	reportingPhase	string
Location Id	locationId	string
Status	status	string
Generated On	generatedOn	string

Example Response

{
  "data": {
    "requestStatus": "2",
    "formInstances": [
      {
        "id": "7be1a2fd-0af0-4f64-8066-3c9fb326331f",
        "formId": "NE_Form2",
        "reportingPeriodFromDate": "2025-04-01",
        "reportingPeriodToDate": "2025-06-30",
        "reportingPeriodicity": "Q",
        "reportingPeriodNum": "02",
        "reportingPhase": "STAND",
        "locationId": "LOC123",
        "status": "GEN",
        "generatedOn": "2025-04-28 19:40:00"
      }
    ],
    "externalReportingEntity": "A001670025"
  }
}

Response Codes

code	description
200	The API response contains the status of the generation request and details of the form instances. Success Response - 200 OK
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. The API will respond with an error if there is an issue with the request parameters.
401	Unauthorized request. The API will respond with an error if the user is not authenticated.
500	Internal server error. The API will respond with an error if there is an unexpected server issue.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/Forms/GenerationRequestStatus

Add Request Headers: